<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>AbstractStateObserver xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/mbari/vcr/timer/AbstractStateObserver.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * @(#)AbstractStateObserver.java   2009.02.24 at 09:44:55 PST</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Copyright 2007 MBARI</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * <a href="http://www.gnu.org/copyleft/lesser.html" target="alexandria_uri">http://www.gnu.org/copyleft/lesser.html</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">package</strong> org.mbari.vcr.timer;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.Timer;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.mbari.util.IObserver;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.*;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">/**</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * Base class for observers that respond to the state of the VCR. These</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * observers send commands to the VCR at regular intervals.</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> */</em>
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/mbari/vcr/timer/AbstractStateObserver.html">AbstractStateObserver</a> implements IObserver {
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> intervalMin = 33;
<a name="34" href="#34">34</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> interval = intervalMin;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>      <em class="jxr_javadoccomment">/**</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">     * This timer is used to read timecode at regular intervals</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">     */</em>
<a name="39" href="#39">39</a>      Timer timer;
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">protected</strong> <a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> vcr;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <em class="jxr_javadoccomment">/**</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * Constructs ...</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     */</em>
<a name="45" href="#45">45</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/timer/AbstractStateObserver.html">AbstractStateObserver</a>() {
<a name="46" href="#46">46</a>          <strong class="jxr_keyword">super</strong>();
<a name="47" href="#47">47</a>      }
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getInterval() {
<a name="50" href="#50">50</a>          <strong class="jxr_keyword">return</strong> interval;
<a name="51" href="#51">51</a>      }
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      Timer getTimer() {
<a name="54" href="#54">54</a>          <strong class="jxr_keyword">return</strong> timer;
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setInterval(<strong class="jxr_keyword">long</strong> interval) {
<a name="58" href="#58">58</a>          <strong class="jxr_keyword">if</strong> (interval &lt; intervalMin) {
<a name="59" href="#59">59</a>              interval = intervalMin;
<a name="60" href="#60">60</a>          }
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>          <strong class="jxr_keyword">boolean</strong> reset = interval != <strong class="jxr_keyword">this</strong>.interval;
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>          <strong class="jxr_keyword">this</strong>.interval = interval;
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">if</strong> (reset &amp;&amp; (getTimer() != <strong class="jxr_keyword">null</strong>)) {
<a name="67" href="#67">67</a>              stopTimer();
<a name="68" href="#68">68</a>              startTimer();
<a name="69" href="#69">69</a>          }
<a name="70" href="#70">70</a>      }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">void</strong> setTimer(Timer timer) {
<a name="73" href="#73">73</a>          <strong class="jxr_keyword">this</strong>.timer = timer;
<a name="74" href="#74">74</a>      }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <em class="jxr_javadoccomment">/**</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;Use this method to set the type of task you will use. We could have</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     *  used reflection and just have a user set the Class of the TimerTask</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     *  to instantiate, but reflection is slow and the VCR application is</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     *  a time-sensitive process. The code implemented should look something like</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     *  this:&lt;/p&gt;</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     *  &lt;pre&gt;</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *  void startTimer() {</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     *      if (getTimer() == null) {</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     *          setTimer(new Timer(true));</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     *          // TimerTask is an impementation of java.util.TimerTask</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     *          getTimer().schedule(new MyTimerTask(), 0, getInterval());</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     *      }</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     *  }</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     *  &lt;/pre&gt;</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     */</em>
<a name="92" href="#92">92</a>      <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> startTimer();
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <strong class="jxr_keyword">void</strong> stopTimer() {
<a name="95" href="#95">95</a>          <strong class="jxr_keyword">if</strong> (getTimer() != <strong class="jxr_keyword">null</strong>) {
<a name="96" href="#96">96</a>              getTimer().cancel();
<a name="97" href="#97">97</a>              setTimer(<strong class="jxr_keyword">null</strong>);
<a name="98" href="#98">98</a>          }
<a name="99" href="#99">99</a>      }
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a>     <em class="jxr_javadoccomment">/**</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @param obj An IVCRState object that will notify the observer of it's</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     *        state change</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * @param changeCode A string change code. This is not currently used.</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     */</em>
<a name="106" href="#106">106</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> update(Object obj, Object changeCode) {
<a name="107" href="#107">107</a>         <a href="../../../../org/mbari/vcr/IVCRState.html">IVCRState</a> state = (IVCRState) obj;
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>         <em class="jxr_comment">//this.vcr = state.</em>
<a name="110" href="#110">110</a>         <strong class="jxr_keyword">if</strong> (state.isStopped() || state.isStill()) {
<a name="111" href="#111">111</a>             stopTimer();
<a name="112" href="#112">112</a>         }
<a name="113" href="#113">113</a>         <strong class="jxr_keyword">else</strong> {
<a name="114" href="#114">114</a>             startTimer();
<a name="115" href="#115">115</a>         }
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

